home *** CD-ROM | disk | FTP | other *** search
/ Acorn RISC PD-CD 1 / Acorn RISC PD-CD 1.iso / utilities / _customise / _hourmake / _help next >
Encoding:
Text File  |  1992-12-01  |  6.8 KB  |  177 lines
  1. HourMake 0.13 (26-Nov-1992)
  2. ===========================
  3.  
  4. © Jon Ribbens and DoggySoft, 1992
  5.  
  6. This program is PUBLIC DOMAIN; this means you can copy it around as much as
  7. you like as long as you don't make any money out of and you include all the
  8. files.
  9.  
  10.  
  11.  
  12. This program is the logical next step from my previous program, 'Hourglass',
  13. which redefined the hourglass to be a nice wood-and-sand one with a
  14. percentage bar up the side. 'Hourglass' is my most successful program to
  15. date, in that (as far as I know) the most people use it and I've actually
  16. received two LETTERS about it! (Cor! Paper and ink!)
  17.  
  18.  
  19.  
  20. HourMake should be reasonably easy to use. After loading, click on the
  21. iconbar icon to open the setup window. There are three main things that
  22. hourglasses 'do' - the animation, the percentange indicator and the LEDs.
  23. HourMake lets you define all of these, partly through sprite files and partly
  24. through the setup window.
  25.  
  26. The first section in the setup window is the 'Sprite files' section. You can
  27. specify a list of sprite files, with commas between each filename. If you
  28. drag a sprite file to the icon, it will be added to the list, unless you are
  29. pressing SHIFT, in which case it replaces the list. When you click 'Create'
  30. later, all the sprite files will be merged together in memory before they
  31. are processed.
  32.  
  33. The sprites needed are:
  34.   'hour1','hour2'...       the hourglass animations
  35.                            they must all be the same size
  36.   'percent1','percent2'... the percentage indicator animations (optional)
  37.                            they must all be the same size
  38.   'led1','led2'...         the LEDs (optional)
  39.                            they must be the same size as 'hour1'
  40.  
  41. Remember that the entire hourglass has a maximum size of 32x32 pixels. The
  42. sprites should be in mode 1 (low resolution) or mode 8 (high resolution).
  43. Note that mode 1 sprites will look thin in high resolution modes and mode 8
  44. sprites will look fat in low resolution modes (sorry, but there's not much I
  45. can do about it).
  46.  
  47. The palette for the hourglass is taken from 'hour1'. If it has no palette
  48. then the palette is not altered - ie. the hourglass will be displayed in
  49. whatever the current mouse colours are when Hourglass_On is called.
  50.  
  51. The second section, 'Animation', allows you to setup the type of animation
  52. your hourglass will have. 'None' means the hourglass won't change, 'Cycle'
  53. means it will continually change from first to last sprite in order, and
  54. 'Yo-yo' means it will go from first to last and then back again.
  55.  
  56. 'Frame delay' specifies the time delay between each frame of the animation.
  57. The minimum is about 10cs, and the maximum is 99cs. 'End delay' specifies the
  58. pause at the end of each run through the animation - ie. after the last frame
  59. is shown in 'Cycle', and after the first or last frame is shown in 'Yo-yo'.
  60.  
  61. The third section, 'Percentage', allows you to define what sort of percentage
  62. indicator your hourglass has:
  63.  
  64.   'None'
  65.     Hourglass_Percentage calls will be ignored.
  66.   'Bar'
  67.     You must have defined two sprites, 'percent1' and 'percent2', as empty
  68.     and full bars respectively. HourMake will then automatically animate the
  69.     bar for you - eg. if the percentage is at 50% then the top half of the
  70.     bar will be shown from 'percent1', and the bottom half from 'percent2'.
  71.     The bar can be on the left or right of the hourglass.
  72.   'Animation'
  73.     You must have defined at least two sprites, 'percent1', 'percent2'...
  74.     If the percentage is set to n% then the sprite n% of the way through the
  75.     list will be displayed. The animation can be on the left or right, or
  76.     above or below the hourglass.
  77.   'Numerals'
  78.     You must have defined 10 or 11 sprites, 'percent1', 'percent2'...
  79.     Sprites 1-9 are the digits 1-9, sprite 10 is 0, and sprite 11 (if
  80.     present) is a percent symbol. The percentage will be displayed as a
  81.     decimal number above or below the hourglass.
  82.  
  83. The last section contains a couple of miscellaneous options. 'Name' allows
  84. you to enter your name to be included in the module. The message 'The sprites
  85. for this hourglass were designed by <name>.' will be included in the
  86. '*Help Hourglass' display.
  87.  
  88. Custom LEDs are specified entirely from a sprite file. You need sprites
  89. 'led1', 'led2', etc. You can have up to 8 LEDs (although no existing software
  90. will use any above 2). To define an LED, copy your 'hour1' sprite to 'led<x>'
  91. (substitute the LED number for <x>) and alter it to include the LED. HourMake
  92. will work out what's changed between 'hour1' and 'led<x>' and store this
  93. information as the LED data.
  94.  
  95.  
  96. Once you have set up all the options, click 'Create'. There will be a pause
  97. of a few seconds while the sprites are converted and the module is created.
  98. A save box will then appear for you to save your module.
  99.  
  100. The new hourglass module provides two extra *Commands:
  101.  
  102.    *Hourglass [ON|OFF|SMASH|<percentage>]
  103.    *Mode [<mode>]
  104.  
  105. It also provides the SWI 'Hourglass_Colours' which is recognised by
  106. RISC OS 3. This SWI allows you to temporarily change the palette of the
  107. hourglass. It won't do anything on this version of HourMake as I haven't
  108. worked out what the parameters are yet. (Not having RO3 doesn't help).
  109.  
  110.  
  111. Just in case you don't have the PRMs, here's what the SWIs do:
  112.  
  113.  
  114. SWI Hourglass_On         &406C0
  115. -------------------------------
  116. Calls Hourglass_Start with R0 set to 33.
  117.  
  118.  
  119. SWI Hourglass_Off        &406C1
  120. -------------------------------
  121. Decrements the count of the number of times the hourglass has been switched
  122. on. If the count reaches zero then the hourglass is turned off.
  123.  
  124.  
  125. SWI Hourglass_Smash      &406C2
  126. -------------------------------
  127. Turns the hourglass off immediately (zeros the 'on count').
  128.  
  129.  
  130. SWI Hourglass_Start      &406C3
  131. -------------------------------
  132. R0 = Delay in centiseconds
  133.  
  134. Sets the hourglass to be turned on after the specified delay. If you specify
  135. a delay of zero and the hourglass is currently off then it will be disabled
  136. until the matching Hourglass_Off to the call or an Hourglass_Smash.
  137.  
  138.  
  139. SWI Hourglass_Percentage &406C4
  140. -------------------------------
  141. R0 = Percentage (0-99) otherwise turn off percentage display
  142.  
  143. Sets the percentage indicator to the specified value if it's in the range
  144. 0-99, otherwise turns off the percentage indicator.
  145.  
  146.  
  147. SWI Hourglass_LEDs       &406C5
  148. -------------------------------
  149. R0 = Bit mask
  150. R1 = EOR word
  151. Exit:
  152. R0 = Old value of LEDs status
  153.  
  154. The LEDs control word is altered as follows:
  155.   New value = (Old value AND R1) EOR R0
  156. The old value is returned in R0.
  157.  
  158.  
  159. SWI Hourglass_Colours    &406C6
  160. -------------------------------
  161. I'm not entirely sure...
  162. Changes the colour of the hourglass, anyway.
  163. Not supported by HourMake (does nothing).
  164.  
  165.  
  166.  
  167. Any information, cash, letters, luxury yachts, etc. to:
  168.  
  169.                 Jon Ribbens
  170.                 39 Nutkins Way
  171.                 Chesham
  172.                 Bucks.
  173.                 HP5 2BE
  174.  
  175. I can also be contacted through Arcade BBS. (It may take a while as I don't
  176. have a modem, but I know a man who does.)
  177.